=====================================================
=== Boutique installation and Config Instructions ===
=====================================================

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! Before you start, backup your worlds, your server, your hard disk, and the !!
!! actual physical components that make up your computer. I suck at java      !!
!! programming, so I can't guarantee that your computer won't melt.           !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

==================
== Instructions ==
==================

=== Pro Instructions ===

1.  Ensure that your MySQL enviroment is prepared for Boutique:
    Boutique automatically creates a table called boutique_shops in which all
    shops are stored. The database name used by Boutique can be configured.
    In future versions of Boutique, the prefix 'boutique_' may be customisable
    and the default shops table renamed 'boutique_shops_shops'
    Ensure an account with appropriate priveledges is ready for Boutique's use.
    Boutique needs to be able to, in the database it uses: create tables;
    select data; insert new data; update data and; delete data;
3.  Copy 'Boutique.jar' to your plugins directory
4.  Create a folder called 'Boutique' in the plugins directory
5.  Copy Config.yml into this folder
6.  Open and edit the Config.yml you just made
8.  Set up permissions. Read 'Setting Up Permissions.txt' for help with what
    permissions do.
9.  Start the server
10. As a basic test, try commands like '/shop create', '/shop open',
    '/shop list' and '/shop'. Also, get another player to try to teleport to
    your shop with '/shop go' (as long as you have allowed anyone else this
    ability).

If you get problems, ensure that 'Reference Table.png' matches the structure
of the database created by the plugin.

=== Noob Instructions ===

Apologies for the patronising tone, I'm trying to catch most ways you could
fail at this and explain what's wrong.

Make sure you're using a craftbukkit server (bukkit.org), and not the 
"vanilla" one from minecraft.net

1. Find the folder where your CraftBukkit server is installed. In that folder is
   a folder called 'plugins'. Open it.
   ---
   If you don't see a folder called plugins, it is likely that you have not
   installed craftbukkit. See here for how to install craftbukkit:
   http://wiki.bukkit.org/Setting_up_a_server

2. Copy 'Boutique.jar' from the folder this file came from into the folder you
   went to in the above step.

3. If your MySQL server is not enabled, please do so now.
   ---
   If you don't know what a MySQL server is, refer to [NOTE 1].

4. Create a new database. The default name for the database is "boutique" (case
   sensitive - it's all lowercase and not UPPERCASE). For some servers, you may
   only have one database. In this case, you will have to configure this plugin
   so that it looks up a different database - this should be really easy and
   we'll deal with this later. 
   ---
   Stuck? Refer to [NOTE 2]

5. A user account for your MySQL database must be able to have the ability to 
   create tables, select data, insert new data, update data, and delete data in
   that database. The default user, "root" has permission to do this, but if you
   can, set up another account with those priveleges. Otherwise, there are
   security risks. Remember the details of the user you have created.
   ---
   Stuck? Refer to [NOTE 2]

6. Start your Craftbukkit server. If it's already on, stop it first.

7. Rememeber the plugins folder? Go back to that.

9. Boutique should have created a new folder in plugins called "Boutique".
   Make sure you are within that folder.

10. There should be a file called Config.yml; open this up to edit it. (Make
    sure it's not the Config.yml in the folder where this help file is located -
    they're identical, but editing one of them makes no difference)
    ---
    Refer to [NOTE 3] if you don't know how to edit a YML file
          - MySQL options:
               Choose the database name: the one from step 4
               Your address will probably be localhost. Your username and
               password will be the details for the account I asked you to
               create ealier. If you chose to use the root account in spite of
               my advice, the password might be "root" or might just be blank.
               When leaving the option blank, do not put in a space after the
               colon.

11. Open up the file 'Setting Up Permissions.txt' to review how the permissions
    system works.
12. Set up permissions. Most important to remember is that if you don't want
    the default permissions, remove Boutique.Default, then add the permissions
    you do want.
    ---
    I can't offer advice on how to add permissions, because my attempts to get
    the inbuilt craftbukkit permissiosns system working to test this plugin have
    failed. I'd suggest using a permissions plugin instead, and you should refer
    to the guidance of the permissions plugin you choose/use if you want help.

13. Restart the server.
14. Test out the following commands: '/shop create', '/shop open', '/shop list', 
    '/shop', and '/shop go'
    If you are not confident that you have set up permissions correctly, you may
    wish to deop yourself (or move to another permissions group) to test out
    whether you have set it up correctly.

If you get problems, ensure that "Reference Table.png" matches the structure
of the database created by the plugin.

================================================================================

[NOTE 1]
MySQL is something which stores information on your computer. If you're using a
desktop/laptop computer, you will be able to install one relatively simply using
a program like WampServer or Lammp/Xammp. These programs install web servers on
your computer, and you might just be able to install MySQL on its own. I don't
know, go Google it. You should be able to Google your way through to having a
MySQL server on your computer.

[NOTE 2]
With Xampp/Lammp and Wamp, you will probably be using phpmyadmin to work on
setting the database up. I think with wamp, you can access it through the
right-click menu of the wamp icon in the bottom right hand corner of your
windows desktop. On my installation of Xammp/lammp (I'm actually not sure which
I have, or if there's a difference), I can access it using a web browser with
the address: http://localhost/phpmyadmin/
I'm not going to guide you through using the interface, because you should be
able to find a guide online somewhere.
Remember that granting all permissions for all databases is just as bad as using
 the root account

[NOTE 3]
Editing a YML file is simple. You have the name of the option, followed by what
you want to set it to. For example:

---------------------
favourite_food: cake
--------------------

You could edit this with your favourite food, for example:

---------------------
favourite_food: cookies
---------------------

Remember to leave the space after the colon before you write how you want to
change the options

Additionaly, YML files can have sub-settings. Say you want to record the
favourite food and favourite minecraft block of you and your friend. You might
set it up like this:

---------------------
dave:
 favourite_food: cake
 favourite_block: stone_bricks
lucy:
 favourite_food: cake
 favourite_block: glowstone
---------------------

I hope this demonstrates how information can be organised. The single space at
the beginning of the line is very important, as it tells the computer that it is
a sub-setting of the last setting above it to contain one less space

When you edit the YML file, don't change the name of any of the settings like,
for example "mysql_databasae". Only change what is after the colon.

